feat: update QUICK_START guide with installation steps - #780
feat: update QUICK_START guide with installation steps#780scottschreckengaust wants to merge 3 commits into
Conversation
|
Small quickstart nit — the guide already has a # Trust mise config and install tools
command -v mise >/dev/null || curl https://mise.run | sh
eval "$(mise activate bash)"Also — is Neither is blocking. |
|
One blocker before the nits:
mise run build # or the docs-generation task
git add docs/src/content/docs/getting-started/Quick-start.mdx |
…nd spot Addresses both review comments on #780. `npm install -g aws-cdk` is not needed. `cdk/package.json` pins `aws-cdk: ^2` as a devDependency and every documented command reaches it through `mise //cdk:*`, which runs `npx cdk` against the workspace binary — Step 3 uses `mise //cdk:bootstrap` and `mise //cdk:deploy`, never a bare `cdk`. A global install can drift from the pinned version and shadow it on PATH, so the line is removed from Step 1 and the stale Prerequisites bullet (which contradicted the note directly below it) now says so explicitly. The `command -v mise` guard and `mise activate` lines are kept as reviewed. Also fixes the gate that let the mirror drift reach CI: the `docs-sync` hook filtered on `^docs/(design|guides)/.*\.md$`, and the `$` after `\.md` means `.mdx` never matched. QUICK_START.mdx is the only `.mdx` guide of 12, and it is exactly the file the hook could not see, so editing it skipped mirror regeneration locally and could only fail CI's "Files were changed during build" check. `sync-starlight.mjs` already knew how to mirror it; only the trigger was blind. The same `\.md$` bug in the trailing-whitespace / end-of-file-fixer excludes is fixed too — latent today (the mirror is clean) but it would pit those fixers against the generator. Starlight mirror regenerated and verified idempotent. Refs #780
532b256 to
be2c20a
Compare
|
Both addressed in
|
Area
cdk— infrastructure, handlers, constructsagent— Python runtime / Docker imagecli—bgagentclientdocs— guides or design sources (docs/guides/,docs/design/)tooling— rootmise.toml, scripts, CI workflowsTip: AGENTS.md lists where to edit and which tests to extend.
Related
Changes
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.